Add OLM disconnected config #16458

adellape · 2019-08-30T20:06:30Z

xref: https://jira.coreos.com/browse/OSDOCS-658

Preview (internal): http://file.rdu.redhat.com/~adellape/083019/olm_disconnected/applications/operators/olm-disconnected.html

adellape · 2019-09-04T19:14:37Z

@ecordell @shawn-hurley FYI on this WIP.

adellape · 2019-09-06T15:58:27Z

@openshift/team-documentation PTAL for peer review.

sferich888 · 2019-09-11T16:40:30Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+CMD ["--database", "bundles.db"]
+----
+
+.. Use the `podman` command to create and tag the container image from the


Do we really want customers building an image?
Shouldn't we be providing this image to customers?

I have no idea who would be responsible for building/pushing and managing these images.

community-operators and certified-operators and redhat-operators are expecting changes, often by individual teams. I don't know how we keep this image up to date or how to tie this to an errata/release process.

@sosiouxme maybe we can chat about this offline?

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

sferich888 · 2019-09-11T16:41:57Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+  └─ <CSVs_and_CRDs_and_a_package_file>
+----
+
+... If you see files already in the structure described in the previous step, then you do not have to do anything.


Shouldn't they be in this format (based on the instructions we are giving in the piro step?

No, there are two different things in the tar potentially. one that is just bundle.yaml and one that is broken up already. This is stating that if you don't see the bundle.yaml then you don't need to do anything. Can we make that more clear? Does that make sense?

sferich888 · 2019-09-11T16:44:49Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+$ curl https://quay.io/cnr/api/v1/packages?namespace=certified-operators >> packages.txt
+----
+
+Each package in the new `packages.txt` is an Operator that you could add to your


Can we explain to customers how to parse this?

Can we provide them a bash script that does all this?

adellape · 2019-09-11T20:03:39Z

@jianzhangbjz @bandrade @scolange PTAL for QE review.

sheriff-rh

Looks good! A couple nitpicks.

sheriff-rh · 2019-09-11T20:22:50Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+$ curl -XGET https://quay.io/cnr/api/v1/packages/community-operators/etcd/blobs/sha256/8108475ee5e83a0187d6d0a729451ef1ce6d34c44a868a200151c36f3232822b -o etcd.tar.gz
+----
+
+.. To pull the information out, you must untar the archive into a directory with


Instead of "pull the information out", what about "To extract the information"?
Same with line 70 above: "use it to extract the gzipped archive"

bandrade

@adellape Just added a suggestion but LGTM for me.

bandrade · 2019-09-17T20:03:05Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+
+.. In this directory, you must now handle two different types of bundles:
+
+... If you see a single file called `bundle.yaml`, you must break the content under


I'm really concerned about letting the user do this step, but I know that are improvements being implemented. Is it possible to add the bundle.yaml in this doc used for this example? That would help the user to associate with their use cases.

@bandrade I've added step 4 about how to break up the file to http://file.rdu.redhat.com/~adellape/083019/olm_disconnected/applications/operators/olm-disconnected.html.

Thanks @adellape, lgmt.

wking · 2019-09-23T21:29:19Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+apiVersion: config.openshift.io/v1
+kind: OperatorHub
+spec:
+  disableAllDefaultSources: true


Nit, you can set this with a copy/pastable command like:

$ oc patch OperatorHub cluster --type json -p '[{"op": "add", "path": "/spec/disableAllDefaultSources", "value": true}]'

to avoid dropping into an editor.

👍 Updated.

adellape · 2019-09-24T21:33:06Z

/cherrypick enterprise-4.2

openshift-cherrypick-robot · 2019-09-24T21:33:14Z

@adellape: new pull request created: #16866

In response to this:

/cherrypick enterprise-4.2

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

wking · 2019-09-25T23:49:47Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+
+----
+$ oc image mirror quay.io/coreos/etcd-operator \
+    <internal_registry_route>:5000/coreos/etcd-operator


Parameterize this port? e.g. we use <local_registry_host_name>:<local_registry_host_port> in a number of other places in the enterprise-4.2 branch (CC @kalexand-rh).

wking · 2019-09-25T23:51:51Z

_topic_map.yml

@@ -511,6 +511,9 @@ Topics:
  - Name: Creating policy for Operator installations and upgrades
    File: olm-creating-policy
    Distros: openshift-origin,openshift-enterprise
+  - Name: Configuring OLM in disconnected mode


The release mirroring PRs went with "restricted network" instead of "disconnected" (e.g. see #16696).

adellape · 2019-09-26T15:13:34Z

@wking @bandrade Thank you, following up via #16892.

sferich888

@vikram-redhat please re-review this PR and look at the denoted comments and consider them for inclusion.

sferich888 · 2019-09-27T16:35:41Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+$ mkdir -p manifests/etcd/ <1>
+$ tar -xf etcd.tar.gz -C manifests/etcd/
+----
+<1> Create different subdirectories for each extracted archive so that files are not


I think this needs to be a call out or warning.

@adellape can you consider modifying this?

A <#> is considered a "callout icon" in AsciiDoc, and I think in this case it's better to keep the connection / context using the numbered icon on the line item (switching to a Warning box would lose that and doesn't seem to add much).

sferich888 · 2019-09-27T16:43:18Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+Dockerfile:
+
+----
+$ podman build -f custom-registry.Dockerfile \


@adellape we need to add a note about setting up podman (to authenticate with the customer portal).
Without this, the build will fail because of the registry being used.

Since we can't link to modules from within a module, I had to add the link to the registry login procedure in the "Additional resources" at the bottom of the assembly:

http://file.rdu.redhat.com/~adellape/083019/olm_disconnected/applications/operators/olm-disconnected.html

sferich888 · 2019-09-27T16:44:16Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+disconnected {product-title} cluster
+
+----
+$ podman push <internal_registry_route>/<namespace>/custom-registry


Should we specify what namespace to push this too?
What authentication needs to be provided to podman for this push to work?

@ecordell @shawn-hurley My understanding was it could be any namespace. Should we state one? Existing or have them create a new one?

This is the same registry and info that is in the main disconnected doc correct? we should just follow that IMO.

sferich888 · 2019-09-27T16:49:23Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+    └── package.yaml
+----
+
+If you see files already in this structure, you can skip this step. However, if


@adellape I think we also need to tell the user to record or pull out the image that is used by the operator versions. We need this for step 8.

Added as a new step 5 in #16892.

sferich888 · 2019-09-27T16:50:17Z

modules/olm-disconnected-operatorhub-disconnected-mode.adoc

+You should also be able to view them from the *OperatorHub* page in the web
+console.
+
+. **Mirror the images required by the Operators you want to use.**


In steps 3 and/or 4 you need to tell the user to pull out or record the image path/url. It is needed in this step.

vikram-redhat · 2019-10-09T01:38:31Z

LGTM from QE received in the followup PR: #16892. Removing QE required flag.

adellape added the branch/enterprise-4.2 label Aug 30, 2019

adellape added this to the Future Release milestone Aug 30, 2019

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 30, 2019

adellape force-pushed the olm_disconnected branch from 5796e9d to 8f29b00 Compare September 3, 2019 13:24

openshift deleted a comment from openshift-docs-preview-bot Sep 4, 2019

adellape force-pushed the olm_disconnected branch from 8f29b00 to e8db3e3 Compare September 6, 2019 14:18

openshift deleted a comment from openshift-docs-preview-bot Sep 6, 2019

adellape force-pushed the olm_disconnected branch 2 times, most recently from 18c07f5 to 5998ab8 Compare September 6, 2019 15:24

adellape changed the title ~~[WIP] Add OLM disconnected config~~ Add OLM disconnected config Sep 6, 2019

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Sep 6, 2019

adellape force-pushed the olm_disconnected branch 3 times, most recently from b4ab0bf to a692f1e Compare September 6, 2019 15:57

openshift deleted a comment from openshift-docs-preview-bot Sep 6, 2019

adellape added the peer-review-needed Signifies that the peer review team needs to review this PR label Sep 6, 2019

sferich888 reviewed Sep 11, 2019

View reviewed changes

modules/olm-disconnected-operatorhub-disconnected-mode.adoc Outdated Show resolved Hide resolved

sferich888 reviewed Sep 11, 2019

View reviewed changes

adellape force-pushed the olm_disconnected branch 4 times, most recently from a083dfe to dbf5d5a Compare September 11, 2019 20:01

openshift deleted a comment from openshift-docs-preview-bot Sep 11, 2019

sheriff-rh approved these changes Sep 11, 2019

View reviewed changes

sheriff-rh added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Sep 11, 2019

bandrade approved these changes Sep 17, 2019

View reviewed changes

adellape force-pushed the olm_disconnected branch 2 times, most recently from 8f40a6d to 23abd99 Compare September 23, 2019 18:03

openshift deleted a comment from openshift-docs-preview-bot Sep 23, 2019

adellape force-pushed the olm_disconnected branch 2 times, most recently from 7f5aaa3 to fad25c3 Compare September 23, 2019 20:40

wking reviewed Sep 23, 2019

View reviewed changes

adellape force-pushed the olm_disconnected branch from fad25c3 to 7f0a967 Compare September 24, 2019 12:30

openshift deleted a comment from openshift-docs-preview-bot Sep 24, 2019

Add OLM disconnected config

903e5f6

adellape force-pushed the olm_disconnected branch from 7f0a967 to 903e5f6 Compare September 24, 2019 19:58

openshift deleted a comment from openshift-docs-preview-bot Sep 24, 2019

adellape merged commit 625bc4c into openshift:master Sep 24, 2019

adellape deleted the olm_disconnected branch September 24, 2019 21:33

openshift-cherrypick-robot mentioned this pull request Sep 24, 2019

[enterprise-4.2] Add OLM disconnected config #16866

Merged

adellape added the QE Required label Sep 24, 2019

wking reviewed Sep 25, 2019

View reviewed changes

adellape mentioned this pull request Sep 26, 2019

Rename OLM topic 'Disconnected' -> 'Restricted network' #16892

Merged

sferich888 reviewed Sep 27, 2019

View reviewed changes

vikram-redhat removed the QE Required label Oct 9, 2019

vikram-redhat modified the milestones: Future Release, OCP 4.2 GA Oct 16, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add OLM disconnected config #16458

Add OLM disconnected config #16458

adellape commented Aug 30, 2019

adellape commented Sep 4, 2019

adellape commented Sep 6, 2019

sferich888 Sep 11, 2019

shawn-hurley Sep 11, 2019

shawn-hurley Sep 11, 2019

sferich888 Sep 11, 2019

shawn-hurley Sep 11, 2019

sferich888 Sep 11, 2019

adellape commented Sep 11, 2019 •

edited

Loading

sheriff-rh left a comment

sheriff-rh Sep 11, 2019

bandrade left a comment

bandrade Sep 17, 2019

adellape Sep 24, 2019

bandrade Sep 25, 2019

wking Sep 23, 2019

adellape Sep 24, 2019

adellape commented Sep 24, 2019

openshift-cherrypick-robot commented Sep 24, 2019

wking Sep 25, 2019

wking Sep 25, 2019

adellape commented Sep 26, 2019

sferich888 left a comment

sferich888 Sep 27, 2019

adellape Oct 2, 2019 •

edited

Loading

sferich888 Sep 27, 2019

adellape Oct 2, 2019

sferich888 Sep 27, 2019

adellape Oct 2, 2019

shawn-hurley Oct 2, 2019

sferich888 Sep 27, 2019

adellape Oct 2, 2019 •

edited

Loading

sferich888 Sep 27, 2019

vikram-redhat commented Oct 9, 2019


		.. In this directory, you must now handle two different types of bundles:

		... If you see a single file called `bundle.yaml`, you must break the content under

Add OLM disconnected config #16458

Add OLM disconnected config #16458

Conversation

adellape commented Aug 30, 2019

adellape commented Sep 4, 2019

adellape commented Sep 6, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape commented Sep 11, 2019 • edited Loading

sheriff-rh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bandrade left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape commented Sep 24, 2019

openshift-cherrypick-robot commented Sep 24, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape commented Sep 26, 2019

sferich888 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape Oct 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adellape Oct 2, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vikram-redhat commented Oct 9, 2019

adellape commented Sep 11, 2019 •

edited

Loading

adellape Oct 2, 2019 •

edited

Loading

adellape Oct 2, 2019 •

edited

Loading